/*
 * Copyright (c) 2020 - present, Inspur Genersoft Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.iec.edp.caf.rpc.api.spi;


import io.iec.edp.caf.rpc.api.entity.RpcContext;

/**
 * this class is rpc context transmitte
 * this class is use to capture context from parent thread
 * and replay this context in sub thread/current thread,finally to restore context;
 */
public interface RpcContextTransmittee {
    String identify();

    /**
     * 捕获上下文
     * @return
     */
    RpcContext capture();

    /**
     * 重放上下文
     * @param newContext 需要重放的上下文信息
     */
    void replay(RpcContext newContext);

    /**
     * 回滚上下文
     * @param newContext 需要回滚的上下文信息
     */
    void restore(RpcContext newContext);

    enum TransmitteType{
        SESSION("caf-session"),
        BIZCONTEXT("caf-bizcontext"),
        FRAMEWORKCONTEXT("caf-frameworkcontext"),
        TENANT("caf-tenant"),
        MSU("caf-msu");

        private String value;

        TransmitteType(String type){
            this.value = type;
        }

        public String getValue() {
            return value;
        }
    }
}
